<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.6"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>My Project: syslog4cj.impl.message.modifier.escape.HTMLEntityEscapeSyslogMessageModifier Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">My Project
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.6 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespacesyslog4cj.html">syslog4cj</a></li><li class="navelem"><a class="el" href="namespacesyslog4cj_1_1impl.html">impl</a></li><li class="navelem"><a class="el" href="namespacesyslog4cj_1_1impl_1_1message.html">message</a></li><li class="navelem"><a class="el" href="namespacesyslog4cj_1_1impl_1_1message_1_1modifier.html">modifier</a></li><li class="navelem"><a class="el" href="namespacesyslog4cj_1_1impl_1_1message_1_1modifier_1_1escape.html">escape</a></li><li class="navelem"><a class="el" href="classsyslog4cj_1_1impl_1_1message_1_1modifier_1_1escape_1_1HTMLEntityEscapeSyslogMessageModifier.html">HTMLEntityEscapeSyslogMessageModifier</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classsyslog4cj_1_1impl_1_1message_1_1modifier_1_1escape_1_1HTMLEntityEscapeSyslogMessageModifier-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">syslog4cj.impl.message.modifier.escape.HTMLEntityEscapeSyslogMessageModifier Class Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for syslog4cj.impl.message.modifier.escape.HTMLEntityEscapeSyslogMessageModifier:</div>
<div class="dyncontent">
 <div class="center">
  <img src="classsyslog4cj_1_1impl_1_1message_1_1modifier_1_1escape_1_1HTMLEntityEscapeSyslogMessageModifier.png" usemap="#syslog4cj.impl.message.modifier.escape.HTMLEntityEscapeSyslogMessageModifier_map" alt=""/>
  <map id="syslog4cj.impl.message.modifier.escape.HTMLEntityEscapeSyslogMessageModifier_map" name="syslog4cj.impl.message.modifier.escape.HTMLEntityEscapeSyslogMessageModifier_map">
<area href="interfacesyslog4cj_1_1common_1_1SyslogMessageModifierIF.html" alt="syslog4cj.common.SyslogMessageModifierIF" shape="rect" coords="0,0,485,24"/>
  </map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a8b6f27a8b8c68f62f0bf9a4ef7d47941"><td class="memItemLeft" align="right" valign="top">public static func&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsyslog4cj_1_1impl_1_1message_1_1modifier_1_1escape_1_1HTMLEntityEscapeSyslogMessageModifier.html#a8b6f27a8b8c68f62f0bf9a4ef7d47941">createDefault</a> ():<a class="el" href="interfacesyslog4cj_1_1common_1_1SyslogMessageModifierIF.html">SyslogMessageModifierIF</a></td></tr>
<tr class="separator:a8b6f27a8b8c68f62f0bf9a4ef7d47941"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2fde8f41886a3a2a7283d8337e60033a"><td class="memItemLeft" align="right" valign="top">public func&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsyslog4cj_1_1impl_1_1message_1_1modifier_1_1escape_1_1HTMLEntityEscapeSyslogMessageModifier.html#a2fde8f41886a3a2a7283d8337e60033a">modify</a> (<a class="el" href="interfacesyslog4cj_1_1common_1_1SyslogIF.html">SyslogIF</a> syslog, Int64 facility, Int64 level, String message):String</td></tr>
<tr class="separator:a2fde8f41886a3a2a7283d8337e60033a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aea522ab2613c7a781b8619e851696461"><td class="memItemLeft" align="right" valign="top">public override func&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsyslog4cj_1_1impl_1_1message_1_1modifier_1_1escape_1_1HTMLEntityEscapeSyslogMessageModifier.html#aea522ab2613c7a781b8619e851696461">verify</a> (String message):Bool</td></tr>
<tr class="separator:aea522ab2613c7a781b8619e851696461"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a753d7131f6150f0ba1cda5c72395f181"><td class="memItemLeft" align="right" valign="top">public static func&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsyslog4cj_1_1impl_1_1message_1_1modifier_1_1escape_1_1HTMLEntityEscapeSyslogMessageModifier.html#a753d7131f6150f0ba1cda5c72395f181">escapeHtml</a> (String message):String</td></tr>
<tr class="separator:a753d7131f6150f0ba1cda5c72395f181"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8f65d76f12bd3b028d7fefb6d1b9a111"><td class="memItemLeft" align="right" valign="top">func&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfacesyslog4cj_1_1common_1_1SyslogMessageModifierIF.html#a8f65d76f12bd3b028d7fefb6d1b9a111">modify</a> (<a class="el" href="interfacesyslog4cj_1_1common_1_1SyslogIF.html">SyslogIF</a> syslog, Int64 facility, Int64 level, String message):String</td></tr>
<tr class="separator:a8f65d76f12bd3b028d7fefb6d1b9a111"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a581a1f2aee3c0fbd34270775e1aab851"><td class="memItemLeft" align="right" valign="top">func&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfacesyslog4cj_1_1common_1_1SyslogMessageModifierIF.html#a581a1f2aee3c0fbd34270775e1aab851">verify</a> (String message):Bool</td></tr>
<tr class="separator:a581a1f2aee3c0fbd34270775e1aab851"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>HTML 实体转义的 Syslog 消息修饰器<br  />
 对日志消息进行 HTML 实体编码，防止在 Web 界面显示日志时触发 XSS 攻击。 适用于将 Syslog 日志输出到 Web 控制台或 HTML 报表的场景。 </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a8b6f27a8b8c68f62f0bf9a4ef7d47941" name="a8b6f27a8b8c68f62f0bf9a4ef7d47941"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8b6f27a8b8c68f62f0bf9a4ef7d47941">&#9670;&#160;</a></span>createDefault()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">public static func syslog4cj.impl.message.modifier.escape.HTMLEntityEscapeSyslogMessageModifier.createDefault </td>
          <td>(</td>
          <td class="paramtype"></td><td>)</td>
          <td>: <a class="el" href="interfacesyslog4cj_1_1common_1_1SyslogMessageModifierIF.html">SyslogMessageModifierIF</a> </td>
        </tr>
      </table>
</div><div class="memdoc">
<p>创建默认修饰器实例</p>
<dl class="section return"><dt>Returns</dt><dd>预配置的 HTML 转义修饰器 </dd></dl>

</div>
</div>
<a id="a753d7131f6150f0ba1cda5c72395f181" name="a753d7131f6150f0ba1cda5c72395f181"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a753d7131f6150f0ba1cda5c72395f181">&#9670;&#160;</a></span>escapeHtml()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">public static func syslog4cj.impl.message.modifier.escape.HTMLEntityEscapeSyslogMessageModifier.escapeHtml </td>
          <td>(</td>
          <td class="paramname"><em>message</em>:&#160;</td>
          <td class="paramtype">String</td><td>)</td>
          <td>: String </td>
        </tr>
      </table>
</div><div class="memdoc">
<p>HTML 实体转义核心方法 转义规则：<br  />
 </p><ul>
<li>
<code class="JavaDocCode">&lt;</code> → <code class="JavaDocCode">&amp;lt;</code> </li>
<li>
<code class="JavaDocCode">&gt;</code> → <code class="JavaDocCode">&amp;gt;</code> </li>
<li>
<code class="JavaDocCode">"</code> → <code class="JavaDocCode">&amp;quot;</code> </li>
<li>
<code class="JavaDocCode">'</code> → <code class="JavaDocCode">&amp;#39;</code> </li>
<li>
<code class="JavaDocCode">&amp;</code> → <code class="JavaDocCode">&amp;amp;</code> </li>
<li>
ASCII 控制字符 → 移除 </li>
<li>
非 ASCII 可打印字符 → 转为数字实体（如 <code class="JavaDocCode">&amp;#20320;</code>） </li>
</ul>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">message</td><td>原始字符串 </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>HTML 转义后的安全字符串 </dd></dl>

</div>
</div>
<a id="a2fde8f41886a3a2a7283d8337e60033a" name="a2fde8f41886a3a2a7283d8337e60033a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2fde8f41886a3a2a7283d8337e60033a">&#9670;&#160;</a></span>modify()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">public func syslog4cj.impl.message.modifier.escape.HTMLEntityEscapeSyslogMessageModifier.modify </td>
          <td>(</td>
          <td class="paramname"><em>syslog</em>:&#160;</td>
          <td class="paramtype">SyslogIF, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramname"><em>facility</em>:&#160;</td>
          <td class="paramtype">Int64, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramname"><em>level</em>:&#160;</td>
          <td class="paramtype">Int64, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramname"><em>message</em>:&#160;</td>
          <td class="paramtype">String&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td>: String </td>
        </tr>
      </table>
</div><div class="memdoc">
<p>对日志消息进行 HTML 实体转义</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">syslog</td><td>Syslog 实例 </td></tr>
    <tr><td class="paramname">facility</td><td>设施类型 </td></tr>
    <tr><td class="paramname">level</td><td>日志级别 </td></tr>
    <tr><td class="paramname">message</td><td>原始日志消息 </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>转义后的安全消息 </dd></dl>

<p>Implements <a class="el" href="interfacesyslog4cj_1_1common_1_1SyslogMessageModifierIF.html#a8f65d76f12bd3b028d7fefb6d1b9a111">syslog4cj.common.SyslogMessageModifierIF</a>.</p>

</div>
</div>
<a id="aea522ab2613c7a781b8619e851696461" name="aea522ab2613c7a781b8619e851696461"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aea522ab2613c7a781b8619e851696461">&#9670;&#160;</a></span>verify()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">public override func syslog4cj.impl.message.modifier.escape.HTMLEntityEscapeSyslogMessageModifier.verify </td>
          <td>(</td>
          <td class="paramname"><em>message</em>:&#160;</td>
          <td class="paramtype">String</td><td>)</td>
          <td>: Bool </td>
        </tr>
      </table>
</div><div class="memdoc">
<p>消息验证（始终通过）</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">message</td><td>待验证消息 </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>总是返回 true </dd></dl>

<p>Implements <a class="el" href="interfacesyslog4cj_1_1common_1_1SyslogMessageModifierIF.html#a581a1f2aee3c0fbd34270775e1aab851">syslog4cj.common.SyslogMessageModifierIF</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/impl/message/modifier/escape/<a class="el" href="html__entity__escape__syslog__message__modifier_8cj.html">html_entity_escape_syslog_message_modifier.cj</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.6
</small></address>
</body>
</html>
